home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmeSecondaryTransfer.z / XmeSecondaryTransfer
Text File  |  1998-10-30  |  12KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr - A toolkit function that transfers
  10.           data from the secondary selection to the destination widget
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/TransferP.h>
  14.           vvvvooooiiiidddd XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr(
  15.           WWWWiiiiddddggggeeeetttt wwwwiiiiddddggggeeeetttt,
  16.           AAAAttttoooommmm ttttaaaarrrrggggeeeetttt,
  17.           XXXXttttEEEEnnnnuuuummmm oooopppp,
  18.           TTTTiiiimmmmeeee ttttiiiimmmmeeee);
  19.  
  20.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  21.           This page documents Motif 2.1.
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.           XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr transfers the data from the secondary
  25.           selection to the destination widget.  A widget usually calls
  26.           this function from an action routine that ends a secondary
  27.           selection.  The destination widget is the owner of the
  28.           ____MMMMOOOOTTTTIIIIFFFF____DDDDEEEESSSSTTTTIIIINNNNAAAATTTTIIIIOOOONNNNselection.
  29.  
  30.           If the destination widget has used XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSiiiinnnnkkkk to take
  31.           ownership of that selection, XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr
  32.           initializes an XXXXmmmmDDDDeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt as follows:
  33.  
  34.              +o  Sets the _s_e_l_e_c_t_i_o_n member to _S_E_C_O_N_D_A_R_Y
  35.  
  36.              +o  Sets the _o_p_e_r_a_t_i_o_n member to XXXXmmmmLLLLIIIINNNNKKKKif the _o_p argument
  37.                 is XXXXmmmmLLLLIIIINNNNKKKK; sets the _o_p_e_r_a_t_i_o_n member to XXXXmmmmCCCCOOOOPPPPYYYYif the
  38.                 _o_p argument is XXXXmmmmCCCCOOOOPPPPYYYY or XXXXmmmmMMMMOOOOVVVVEEEE.
  39.  
  40.              +o  Sets the _d_e_s_t_i_n_a_t_i_o_n__d_a_t_a member to the value of the
  41.                 _t_a_r_g_e_t argument
  42.  
  43.           XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr makes the following sequence of calls:
  44.  
  45.              1. Calls the destination widget's
  46.                 ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrreeeeHHHHooooooookkkkPPPPrrrroooocccctrait method, if any.
  47.                 ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrreeeeHHHHooooooookkkkPPPPrrrrooooccccis one of the trait methods of
  48.                 the _X_m_Q_T_t_r_a_n_s_f_e_r trait.  XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr passes
  49.                 the initialized XXXXmmmmDDDDeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt as the
  50.                 _c_a_l_l__d_a_t_a argument to the trait method.
  51.  
  52.              2. Calls the application's XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk
  53.                 procedures, if any.
  54.  
  55.              3. Calls the destination widget's ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrroooocccctrait
  56.                 method, if any, after all transfers initiated by the
  57.                 XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkprocedures have finished.
  58.                 However, if an XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedure has
  59.                 called _X_m_T_r_a_n_s_f_e_r_D_o_n_e with a status of
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                 XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____DDDDOOOONNNNEEEE____DDDDEEEEFFFFAAAAUUUULLLLTTTT, then XXXXmmmmeeeePPPPrrrriiiimmmmaaaarrrryyyySSSSiiiinnnnkkkk will not
  75.                 call the ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrroooocccctrait method.
  76.  
  77.           It is the responsibility of the destination widget's
  78.           XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedures and the
  79.           ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrroooocccctrait method to transfer any data to the
  80.           widget.
  81.  
  82.           If _o_p is XXXXmmmmMMMMOOOOVVVVEEEE and the data is successfully transferred,
  83.           XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr asks the owner of the
  84.           _S_E_C_O_N_D_A_R_Yselection to convert that selection to the _D_E_L_E_T_E
  85.           target.  In all cases, when the transfer operation is
  86.           complete, XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr asks the owner of the
  87.           _S_E_C_O_N_D_A_R_Yselection to convert that selection to the
  88.           ____MMMMOOOOTTTTIIIIFFFF____LLLLOOOOSSSSEEEE____SSSSEEEELLLLEEEECCCCTTTTIIIIOOOONNNNtarget.
  89.  
  90.           If the selection owner has called XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSoooouuuurrrrcccceeee to take
  91.           ownership of the selection, these conversion requests first
  92.           call the owner's XXXXmmmmNNNNccccoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkk procedures, if any.  If
  93.           no XXXXmmmmNNNNccccoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkk procedures exist or if these
  94.           procedures return a status of XXXXmmmmCCCCOOOONNNNVVVVEEEERRRRTTTT____DDDDEEEEFFFFAAAAUUUULLLLTTTT or
  95.           XXXXmmmmCCCCOOOONNNNVVVVEEEERRRRTTTT____MMMMEEEERRRRGGGGEEEE, these requests then call the owner's
  96.           ccccoooonnnnvvvveeeerrrrttttPPPPrrrroooocccc trait method; ccccoooonnnnvvvveeeerrrrttttPPPPrrrroooocccc is a trait method of
  97.           the _X_m_Q_T_t_r_a_n_s_f_e_r trait.
  98.  
  99.           _w_i_d_g_e_t    Specifies the widget that is the owner of the
  100.                     secondary selection.
  101.  
  102.           _t_a_r_g_e_t    Specifies a recommended target for the destination
  103.                     widget to request when converting the secondary
  104.                     selection.
  105.  
  106.           _o_p        Specifies the transfer operation.  Possible values
  107.                     are XXXXmmmmMMMMOOOOVVVVEEEE, XXXXmmmmCCCCOOOOPPPPYYYY, and XXXXmmmmLLLLIIIINNNNKKKK.
  108.  
  109.           _t_i_m_e      Specifies the time of the transfer.  This is
  110.                     usually the timestamp from the event passed to an
  111.                     action routine.  You should call
  112.                     _X_t_L_a_s_t_T_i_m_e_S_t_a_m_p_P_r_o_c_e_s_s_e_d to generate the
  113.                     _t_i_m_evalue.  If you set _t_i_m_e to CCCCuuuurrrrrrrreeeennnnttttTTTTiiiimmmmeeee or 0,
  114.                     UTM will automatically change the call to
  115.                     _X_t_L_a_s_t_T_i_m_e_S_t_a_m_p_P_r_o_c_e_s_s_e_d.
  116.  
  117.      RRRREEEELLLLAAAATTTTEEEEDDDD
  118.           XXXXmmmmQQQQTTTTttttrrrraaaannnnssssffffeeeerrrr(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee(3),
  119.           XXXXmmmmeeeeCCCClllliiiippppbbbbooooaaaarrrrddddSSSSiiiinnnnkkkk(3), XXXXmmmmeeeeCCCClllliiiippppbbbbooooaaaarrrrddddSSSSoooouuuurrrrcccceeee(3),
  120.           XXXXmmmmeeeeCCCCoooonnnnvvvveeeerrrrttttMMMMeeeerrrrggggeeee(3), XXXXmmmmeeeeDDDDrrrraaaaggggSSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeDDDDrrrrooooppppSSSSiiiinnnnkkkk(3),
  121.           XXXXmmmmeeeeGGGGeeeettttEEEEnnnnccccooooddddiiiinnnnggggAAAAttttoooommmm(3), XXXXmmmmeeeePPPPrrrriiiimmmmaaaarrrryyyySSSSiiiinnnnkkkk(3),
  122.           XXXXmmmmeeeePPPPrrrriiiimmmmaaaarrrryyyySSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSiiiinnnnkkkk(3),
  123.           XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt(3),
  124.           XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddTTTTaaaarrrrggggeeeettttssss(3), and XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc(3).
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.